Instances APIs

Instances APIs

The Instances service provides operations to create and delete a namespace object. In this version, an Instance is an abstraction around a Kubernetes namespace.

Operations
POST
Create Namespaces Instances
Create a namespace object on a single vSphere cluster.
GET
List Namespaces Instances
Returns the information about all namespaces in this vCenter Server. The information is tied to a single vSphere cluster.
POST
Create Namespaces Instances V2
Create a namespace object on a Supervisor.
GET
Get Namespaces Instances V2
Returns the information about all namespaces in this vCenter Server. The information is tied to a Supervisor.
DELETE
Delete Namespace Instances
Delete the namespace object in the cluster.
GET
Get Namespace Instances
Returns information about a specific namespace on a single vSphere cluster.
PUT
Set Namespace Instances
Set a new configuration on the namespace object. The specified configuration is applied in entirety and will replace the current configuration fully.
PATCH
Update Namespace Instances
Update the namespace object. The specified configuration is applied partially and unset fields in spec will leave those parts of configuration as-is.
GET
Get Namespace Instances V2
Returns information about a specific namespace on a Supervisor.
POST
Create Namespace Instances Registervm
Register an existing virtual machine as VM Service managed VM. This API reads data stored in a VM's ExtraConfig to create a Kubernetes resource that may be used to lifecycle manage the VM. This process may also result in the creation of a Secret or ConfigMap resource for the VM's bootstrap data. Finally, a PersistentVolumeClaim resource may be created for each of the first-class disks attached to the VM. This API triggers a non-cancellable task and returns its identifier which can be queried by calling the cis Tasks get operation. The task is retained as per the default retention rules configured in vCenter. This is a non-idempotent API that creates custom resources on the Supervisor as a side effect. If the API returns an error VI admin might need to manually address them before attempting registration again.